Skip to content

Comments

Refresh README for marketing clarity#2

Open
chee86j wants to merge 1 commit intomainfrom
codex/revise-readme.md-for-professionalism-6g3535
Open

Refresh README for marketing clarity#2
chee86j wants to merge 1 commit intomainfrom
codex/revise-readme.md-for-professionalism-6g3535

Conversation

@chee86j
Copy link
Owner

@chee86j chee86j commented Jan 1, 2026

Summary

  • rewrite README with a sharper overview of gameplay, mechanics, and tech stack
  • add quickstart, deployment, and troubleshooting details tailored for fast onboarding
  • tighten feature highlights and roadmap for a professional presentation

Testing

  • not run (documentation only)

Codex Task


Note

Refreshes project documentation for clarity and faster onboarding.

  • Restructures README with sections: Why, Feature Highlights, Tech Stack, Quickstart, Available Scripts, Gameplay Overview, Project Structure, Deployment, Troubleshooting, and Roadmap
  • Adds setup guidance (npm install, npm run dev, npm run build, npm run preview) and clarifies script purposes
  • Details deployment steps, including Railway commands (npm run preview -- --host 0.0.0.0 --port $PORT)
  • Expands gameplay docs (rehab gating, profession-weighted events, dice outcomes) and notes a single <ToastContainer /> in App.tsx
  • Updates project structure comments for src/assets/gameData.ts and key components

Written by Cursor Bugbot for commit 86fd573. This will update automatically on new commits. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant